Skip to main content
Search for External Companies based on free text
curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/companies/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "Bakery",
  "location": {
    "lat": 51.0216707,
    "lng": 3.6887328
  },
  "filters": [
    {
      "filter": "max_geo_distance",
      "max_geo_distance": 50
    },
    {
      "filter": "custom_property",
      "property_name": "direct_manager",
      "property_value": "John Doe"
    },
    {
      "filter": "custom_property_is_in_list",
      "property_name": "drivers_license",
      "possible_values": [
        "C",
        "CE"
      ]
    },
    {
      "filter": "custom_property_contains_element",
      "property_name": "industries",
      "property_value": "electronics"
    },
    {
      "filter": "external_id_is_in_list",
      "external_ids": [
        "external_id_1",
        "external_id_2",
        "external_id_3"
      ]
    }
  ],
  "weights": [
    {
      "weight": "max_geo_distance",
      "value": 0.1,
      "full_score_distance": 5,
      "zero_score_distance": 15
    },
    {
      "weight": "custom_property",
      "property_name": "direct_manager",
      "property_value": "John Doe",
      "operator": "eq",
      "value": 0.04
    },
    {
      "weight": "custom_property",
      "property_name": "yearly_salary",
      "property_value": 45000,
      "operator": "gte",
      "value": 0.04
    }
  ]
}'
{
  "results": [
    {
      "company_id": "cuid-123",
      "score": 0.9,
      "matching_vacancies": [
        {
          "vacancy_id": "a4003805-eb84-42dc-a79f-5e7b1fe897b7",
          "score": 0.9,
          "job_title": "Business Analyst"
        },
        {
          "vacancy_id": "b4003805-eb84-42dc-a79f-5e7b1fe897b7",
          "score": 0.7,
          "job_title": "Data Scientist"
        }
      ]
    },
    {
      "company_id": "cuid-456",
      "score": 0.8,
      "matching_vacancies": [
        {
          "vacancy_id": "e1d2b367-d899-474f-a3e4-4f926e2bf6d9",
          "score": 0.8,
          "job_title": "Software Engineer"
        },
        {
          "vacancy_id": "3d21ce18-f599-43e6-9a57-10e13916f1dd",
          "score": 0.7,
          "job_title": "Data Scientist"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
limit
integer
default:10

The maximal number of results returned.

Required range: 1 <= x <= 100
Example:

10

​
offset
integer
default:0

The rank offset for returned matches, return matches starting from rank offset up to rank offset+limit.

Required range: x >= 0
​
score_min_threshold
number
default:0.5

The minimum score of the results. Due to approximations for fast result-delivery, there might be records with a score slightly lower than the minimum.

Required range: 0 <= x <= 1
Example:

0.7

​
language
enum<string>
default:auto

The language of the input text. auto will automatically detect the language used.

Available options:
auto,
nl,
fr,
en,
de
Example:

"en"

Body

application/json

Request structure for free text search.

​
text
string
required

Input text.

Example:

"Bakery"

​
filters
(max_geo_distance · object | custom_property · object | custom_property_is_in_list · object | custom_property_contains_element · object | external_id_is_in_list · object)[]
required
  • max_geo_distance
  • custom_property
  • custom_property_is_in_list
  • custom_property_contains_element
  • external_id_is_in_list
Example:
[
  {
    "filter": "max_geo_distance",
    "max_geo_distance": 50
  },
  {
    "filter": "custom_property",
    "property_name": "direct_manager",
    "property_value": "John Doe"
  },
  {
    "filter": "custom_property_is_in_list",
    "property_name": "drivers_license",
    "possible_values": ["C", "CE"]
  },
  {
    "filter": "custom_property_contains_element",
    "property_name": "industries",
    "property_value": "electronics"
  },
  {
    "filter": "external_id_is_in_list",
    "external_ids": [
      "external_id_1",
      "external_id_2",
      "external_id_3"
    ]
  }
]
​
weights
(geo_distance · object | custom_property · object | skills_match · object)[]
required
  • geo_distance
  • custom_property
  • skills_match
Example:
[
  {
    "weight": "max_geo_distance",
    "value": 0.1,
    "full_score_distance": 5,
    "zero_score_distance": 15
  },
  {
    "weight": "custom_property",
    "property_name": "direct_manager",
    "property_value": "John Doe",
    "operator": "eq",
    "value": 0.04
  },
  {
    "weight": "custom_property",
    "property_name": "yearly_salary",
    "property_value": 45000,
    "operator": "gte",
    "value": 0.04
  }
]
​
location
object

A geographic location, expressed in latitude and longitude. This can represent a home address, an office location... Each entity is limited to having a single location. To get the latitude and longitude for a given address, you can use the Google Maps Geocoding API or a predefined lookup table (for example by zip code). If location is present in matching or filters, it will act as an override for geo-distance calculations.

  • Location
  • Address

Response

OK

​
results
object[]
required

List of search results.

⌘I